/*
 * Remote-port ATS device.
 *
 * In a QEMU co-simulation, this module allows SystemC to model a PCIe EP
 * issuing ATS requests towards QEMU.
 *
 * Copyright (c) 2021 Xilinx Inc
 * Written by Francisco Iglesias
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef REMOTE_PORT_TLM_ATS_H
#define REMOTE_PORT_TLM_ATS_H

#include <assert.h>
#include "remote-port-tlm.h"

class remoteport_tlm_ats
	: public sc_module, public remoteport_tlm_dev
{
public:
	SC_HAS_PROCESS(remoteport_tlm_ats);

	tlm_utils::simple_target_socket<remoteport_tlm_ats> req;
	tlm_utils::simple_initiator_socket<remoteport_tlm_ats> inv;

	remoteport_tlm_ats(sc_module_name name);

	void cmd_ats_inv(struct rp_pkt &pkt, bool can_sync);
	void tie_off(void);

	static void cmd_ats_inv_null(remoteport_tlm *adaptor,
					struct rp_pkt &pkt,
					bool can_sync,
					remoteport_tlm_ats *dev);
private:
	tlm_utils::simple_initiator_socket<remoteport_tlm_ats> *tieoff_req;
	tlm_utils::simple_target_socket<remoteport_tlm_ats> *tieoff_inv;

	virtual void b_transport(tlm::tlm_generic_payload& trans,
				 sc_time& delay);

	void ats_invalidate(struct rp_pkt &pkt);
};

#endif
